feat(#2369): Add `webdev_colors_folder` option #2375

antoniosarosi · 2023-08-14T22:36:12Z

Implements feature #2369

I started writing a little draft to provide an option that allows the user to change the icon and color of a directory based on its name. I added a new option webdev_colors_folder and I changed the get_folder_icon function as mentioned here. Now you can do this:

require("nvim-web-devicons").setup {
    strict = true,
    override_by_filename = {
        [".git"] = {
            icon = "",
            color = "#ff0000",
            name = "Gitignore"
        },
        [".github"] = {
            icon = "",
            color = "#ff0000",
            name = "Github"
        },
    }
}

require("nvim-tree").setup {
  renderer = {
    icons = {
      webdev_colors_folder = true,
    }
  }
}

And get this result:

Click to show screenshot

But I have some questions before continuing. nvim-web-devicons doesn't distinguish between directories and files, so if you create a file that matches one of the override_by_filename keys it will get the same icon and color, which maybe you intended only for directories, not files. I am not sure how to override only directory names.

On the other hand, what should happen with overriden icons when the directory is open VS closed? Should it use the same overriden icon for both cases, use the overriden icon only for closed directories while using glyphs.folder.open for open directories, or should it allow the user to customize both closed and open icons/colors? I think the last option is not possible with override_by_filename as nvim-web-devicons doesn't know whether a directory is closed or not, that is handled by nvim-tree.

Finally, I'm not sure if get_folder_icon should return both the icon and highlight or if there should be an equivalent to Builder:_get_highlight_override, I implemented it as simply as I could.

alex-courtis · 2023-08-15T00:18:41Z

On the other hand, what should happen with overriden icons when the directory is open VS closed?

I'm happy to use the same one for open vs closed. The user can see the state via the arrows or indent markers.

Finally, I'm not sure if get_folder_icon should return both the icon and highlight or if there should be an equivalent to Builder:_get_highlight_override, I implemented it as simply as I could.

We can follow the file pattern i.e. create a get_folder_icon_webdev which should simplify things.

alex-courtis · 2023-08-15T00:37:31Z

We do have an issue: folder icons will appear for users when they didn't previously. We need to preserve existing behaviour.

There are really two questions for files and folders:

show webdev icon
colourise webdev icon

For 1 we have no solution, which I think #2361 is about. The only way to prevent icons is to disable the plugin.

Proposal: add options:
0001-granular-web_devicons-config.patch.gz

We will need to add a silent refactor of renderer.icons.webdev_colors to renderer.icons.web_devicons.file.color in legacy.lua to not break existing users.

alex-courtis

Many thanks for the contribution; this will resolve a larger problem.

lua/nvim-tree/renderer/components/icons.lua

antoniosarosi · 2023-08-15T12:49:00Z

We do have an issue: folder icons will appear for users when they didn't previously. We need to preserve existing behaviour.

Isn't this controlled by the new webdev_colors_folder option? Since it's set to false by default, folder icons should behave the same as before unless the user sets the option to true , or am I misunderstanding?

alex-courtis · 2023-08-16T00:18:40Z

Many thanks for the updates. I'll get to this on the weekend.

alex-courtis · 2023-08-20T05:09:57Z

Isn't this controlled by the new webdev_colors_folder option? Since it's set to false by default, folder icons should behave the same as before unless the user sets the option to true , or am I misunderstanding?

I'm scope creeping here. We never had any mechanism for controlling the display of icons, just their colour.

We require both controls for folders to prevent breaking existing folder icon behaviour. We should add both controls for file icons now, as the configuration and behaviour would be very inconsistent between files and folders.

antoniosarosi · 2023-08-20T14:39:13Z

I'm scope creeping here. We never had any mechanism for controlling the display of icons, just their colour.

Still not sure what you mean, if you use override_by_filename option when setting up nvim-web-devicons you can change the icon of any file. Then there's also webdev_colors in nvim-tree which is set to true by default. So you can control both icons and colors of files using a combination of override_by_filename and webdev_colors.

webdev_colors_folder does almost the same except you can't control icons and colors separately, is that the issue?

Maybe splitting it into two options like webdev_colors_folder and webdev_icons_folder would be better? That would allow the user to only change the icons or both icons and colors of directories.

alex-courtis · 2023-08-21T01:10:29Z

Maybe splitting it into two options like webdev_colors_folder and webdev_icons_folder would be better? That would allow the user to only change the icons or both icons and colors of directories.

Yes please.

Please git apply 0001-granular-web_devicons-config.patch the patch linked above. I've drafted all those options in help.

Don't worry about the migration; I'll do that after you've finished the functionality.

antoniosarosi · 2023-08-21T21:23:41Z

I applied the patch and implemented web_devicons.file and web_devicons.folder options. I tested all the combinations and it seems to work pretty well. Let me know if you find any bug.

alex-courtis · 2023-08-21T23:18:00Z

That's fantastic! I'll get to this on the weekend.

…devicons.file.color

alex-courtis

Works beautifully:

file = { enable = false, color = false, }, folder = { enable = false, color = false, },
file = { enable = false, color = false, }, folder = { enable = false, color = true, },
file = { enable = false, color = false, }, folder = { enable = true, color = false, },
file = { enable = false, color = false, }, folder = { enable = true, color = true, },

file = { enable = false, color = true, }, folder = { enable = true, color = true, },
file = { enable = true, color = true, }, folder = { enable = true, color = true, },
file = { enable = true, color = false, }, folder = { enable = true, color = true, },

renderer.icons.webdev_colors -> renderer.icons.web_devicons.file.color

Many thanks for your contribution, you have gone well beyond the call of duty.

…devicons.file.color

Add webdev_colors_folder option

cc5c5e8

alex-courtis requested changes Aug 15, 2023

View reviewed changes

lua/nvim-tree/renderer/components/icons.lua Outdated Show resolved Hide resolved

antoniosarosi added 2 commits August 15, 2023 15:48

Check if M.devicons exists

5d26121

Refactor get_folder_icon

f5c7207

antoniosarosi requested a review from alex-courtis August 15, 2023 14:04

Merge branch 'master' into master

f3783d3

antoniosarosi added 3 commits August 21, 2023 23:16

Add configuration options for both files and folders

4d596b3

Merge branch 'nvim-tree:master' into master

731ccd9

Merge branch 'master' of github.com:antoniosarosi/nvim-tree.lua

6ce79fc

alex-courtis added 3 commits August 26, 2023 14:18

Merge branch 'master' into master

e4c123b

web_devicons.*.enabled -> enable

6a04a25

silent migration: renderer.icons.webdev_colors -> renderer.icons.web_…

67e0e3c

…devicons.file.color

alex-courtis approved these changes Aug 26, 2023

View reviewed changes

silent migration: renderer.icons.webdev_colors -> renderer.icons.web_…

37182ed

…devicons.file.color

alex-courtis merged commit b144b33 into nvim-tree:master Aug 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(#2369): Add `webdev_colors_folder` option #2375

feat(#2369): Add `webdev_colors_folder` option #2375

Uh oh!

antoniosarosi commented Aug 14, 2023

Uh oh!

alex-courtis commented Aug 15, 2023

Uh oh!

alex-courtis commented Aug 15, 2023

Uh oh!

alex-courtis left a comment

Uh oh!

Uh oh!

antoniosarosi commented Aug 15, 2023

Uh oh!

alex-courtis commented Aug 16, 2023

Uh oh!

alex-courtis commented Aug 20, 2023

Uh oh!

antoniosarosi commented Aug 20, 2023

Uh oh!

alex-courtis commented Aug 21, 2023 •

edited

Loading

Uh oh!

antoniosarosi commented Aug 21, 2023

Uh oh!

alex-courtis commented Aug 21, 2023

Uh oh!

alex-courtis left a comment

Uh oh!

Uh oh!

Uh oh!

feat(#2369): Add webdev_colors_folder option #2375

feat(#2369): Add webdev_colors_folder option #2375

Uh oh!

Conversation

antoniosarosi commented Aug 14, 2023

Uh oh!

alex-courtis commented Aug 15, 2023

Uh oh!

alex-courtis commented Aug 15, 2023

Uh oh!

alex-courtis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

antoniosarosi commented Aug 15, 2023

Uh oh!

alex-courtis commented Aug 16, 2023

Uh oh!

alex-courtis commented Aug 20, 2023

Uh oh!

antoniosarosi commented Aug 20, 2023

Uh oh!

alex-courtis commented Aug 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

antoniosarosi commented Aug 21, 2023

Uh oh!

alex-courtis commented Aug 21, 2023

Uh oh!

alex-courtis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

feat(#2369): Add `webdev_colors_folder` option #2375

feat(#2369): Add `webdev_colors_folder` option #2375

alex-courtis commented Aug 21, 2023 •

edited

Loading